id: version-1 title: Connect API v1 meta: Reference for the Infinite Flight Connect API Version 1 order: 2 contributor: KaiM,nicolas #

Connect API v1 #

This documentation is for Version 1 of the Connect API. Using this API is no longer recommended due to it’s slow speed and limited features. See the Version 2 Documentation for more information.

The Connect API v1 is being sunsetted and will be removed in update 23.1. See here for further details.{.red}

Connection #

1. To enable Infinite Flight command server, check Enable Infinite Flight Connect in Settings > General

2. Infinite Flight will broadcast UDP packets on port 15000 containing its own IP address and Port. Example message: { "Address": "192.168.0.11", "Port": 10111 }

3. You must then establish a TCP connection on this given host and port

Get Airplane State #

This special command will request the airplane state from Infinite Flight. Response will be received on the same socket: { "Command": "Airplane.GetState", "Parameters": []}

Command Messages #

A command message is a object of the following form :

There are two types of command messages:

• Commands: { "Command": "Commands.{CommandName}", "Parameters": []}
• Axis: { "Command": "NetworkJoystick.{AxisCommandName}", "Parameters": []}

List of commands #

Joystick #

Joystick axis use the NetworkJoystick.SetAxisValue command with two parameters:

• Axis Name: 0 for Roll, 1 for Pitch
• Value: a value between -1024 and 1024

Example :

{
  "Command": "NetworkJoystick.SetAxisValue",
  "Parameters": [ { "Name": 0, "Value": -340 } ]
}

Plane Systems #

Commands to control various systems of the plane. For example, to lower flaps down:

{
  "Command": "Commands.FlapsDown",
  "Parameters": []
}

Lights #

Following commands toggle the state of a light. For example:

{
  "Command": "Commands.LandingLights",
  "Parameters": []
}

Camera #

Camera Commands

Following commands can be used to control cameras. For example:

{
  "Command": "Commands.NextCamera",
  "Parameters": []
}

For camera moves, see Axis commands below

Camera Axis

Camera POV movements can be controlled via the following command:

{
  "Command": "NetworkJoystick.SetPOVState",
  "Parameters": [
    { "Name": "X", "Value": 0 },
    { "Name": "Y", "Value": 0 }
  ]
}

X and Y values can be either -1, 0 or 1: they determine if the camera will move on each axis, either negatively or positively (or stay still on the given axis with the 0 value). For example, to move the POV to the left only horizontally, use the following command :

{
  "Command": "NetworkJoystick.SetPOVState",
  "Parameters": [
    { "Name": "X", "Value": -1 },
    { "Name": "Y", "Value": 0 }
  ]
}

ATC (Live Mode Only) #

Allows you to send messages to ATC according to the options available on the ATC window. Example, call the ATC command #3 (as shown on the ATC window) :

{
  "Command": "Commands.ATCEntry3",
  "Parameters": []
}

Autopilot and Flight Plan #

Commands to set the value of an Autopilot param, or to toggle its state.

Examples

Set HDG to 270

{
  "Command": "Commands.Autopilot.SetHeading",
  "Parameters": [{ "Value": 270 }]
}

Enable HDG

{
  "Command": "Commands.Autopilot.SetHeadingState",
  "Parameters": [{ "Value": true }]
}

Toggle AP

{
  "Command": "Commands.Autopilot.Toggle",
  "Parameters": []
}

Simulator Commands #

Control on simulator. Example, toggle play/pause.

{
  "Command": "Commands.TogglePause",
  "Parameters": []
}